Certificate Store Discovery
The certificate store discovery feature is used to scan machines and devices for existing certificates and certificate stores, which can then be configured for management in Keyfactor Command. Certificate store discovery is supported for the following built-in certificate stores and Keyfactor-provided custom-built extensions on GitHub:
-
PEM
and Java certificate stores discovered by the Keyfactor Java Agent
. Only stores on which the service account running the Keyfactor Java Agent has at least read permissions will be returned on a discover job.
-
F5 CA
bundles and F5 SSL
certificates discovered using the F5 Certificate Store Manager extension from Keyfactor GitHub and the Keyfactor Universal Orchestrator
.
-
Java Keystores, PKCS12 files, PEM files, DER
files, and IBM Key Database files discovered using the Remote File Certificate Store Management extension from Keyfactor GitHub and the Keyfactor Universal Orchestrator
.
The small number that appears on the tab to the right of the word Discover indicates how many discovered stores there are, if any. This acts as a reminder to check the discover tab for stores after a discovery job is complete.
The following table includes only default fields for discovery jobs, not any custom fields specific to a certain certificate store type.
Option |
Description |
---|---|
Category | Select the type of certificate store to scan. |
Orchestrator |
Select the fully qualified domain name of the Keyfactor Universal Orchestrator managing the scanning. This field is required. |
Schedule |
Specify the schedule for the scan—Immediate or Exactly Once. If you select Exactly Once, select a date and time for the scan. The default is Immediate. |
Client Machine | Specify the fully qualified domain name or IP address of the remote target, device or cluster to be scanned for certificates. This field is required. |
Server Username | Set the username used to authenticate to the remote target, device or cluster. |
Server Password | Set the password used to authenticate to the remote target, device or cluster. |
Directories to search |
Specify the directory or directories to be searched. Multiple directories should be separated by commas. All directories specified to which the specified user (see Server Username) has read rights will be searched other than the excluded directories specified using the Directories to ignore option. It is not necessary to use quotation marks around directory paths containing spaces. For F5, the path should be specified as "/" (without the quotation marks). This field is required. |
Directories to ignore |
Specify any directories that should not be included in the search. Multiple directories should be separated by commas. It is not necessary to use quotation marks around directory paths containing spaces. |
Extensions |
Specify file extensions for which to search. For example, search for files with the extension jks but not txt. The dot should not be included when specifying extensions. To include files without extensions, include noext in the extension list. For example: jks, noext
|
File name patterns to match |
Specify all or part of a string against which to compare the file names of certificate store files and return only those that contain the specified string. It is not necessary to use quotation marks around strings containing spaces. |
Follow SymLinks |
If this option is specified, the tool will follow symbolic links on Linux and UNIX operating systems and report both the actual location of a found certificate store file in addition to the symbolic link pointing to the file. This option is ignored for searches of Windows-based targets. |
Include PKCS12 Files |
If this option is specified, the tool will use the compatibility mode introduced in Java version 1.8 to locate both JKS and PKCS12 type files if supported by the extension. This option applies only to Java keystore discover jobs. |
Use SSL |
Use SSL to communicate to the remote target, device or cluster. If the remote target is an F5 device and you’re using the F5 extension, the device must trust the CA that issued the certificate used to protect the Keyfactor Command server or you must set the Ignore Server SSL Warnings application setting to True (see Application Settings). If the remote target is a Windows server and you’re using the Remote File or IIS extension, WinRM on the target must be configured to support HTTPS and have been configured with an SSL certificate (see Configure Windows Targets for Remote Management). |
Inventory Schedule |
You can choose to run the inventory Daily, on an Interval, Immediately, Weekly, Exactly Once, or set inventorying to Off. |